/****************************************************************************
 *
 * Copyright 2018 Samsung Electronics All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific
 * language governing permissions and limitations under the License.
 *
 ****************************************************************************/
/*
 * lcp.h - Link Control Protocol definitions.
 *
 * Copyright (c) 1984-2000 Carnegie Mellon University. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The name "Carnegie Mellon University" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For permission or any legal
 *    details, please contact
 *      Office of Technology Transfer
 *      Carnegie Mellon University
 *      5000 Forbes Avenue
 *      Pittsburgh, PA  15213-3890
 *      (412) 268-4387, fax: (412) 268-7395
 *      tech-transfer@andrew.cmu.edu
 *
 * 4. Redistributions of any form whatsoever must retain the following
 *    acknowledgment:
 *    "This product includes software developed by Computing Services
 *     at Carnegie Mellon University (http://www.cmu.edu/computing/)."
 *
 * CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
 * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
 * FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
 * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *
 * $Id: lcp.h,v 1.20 2004/11/14 22:53:42 carlsonj Exp $
 */

#include "lwip/netif/ppp/ppp_opts.h"
#if PPP_SUPPORT					/* don't build if not configured for use in lwipopts.h */

#ifndef LCP_H
#define	LCP_H

#include "ppp.h"

/*
 * Options.
 */
#define CI_VENDOR	0			/* Vendor Specific */
#define CI_MRU		1			/* Maximum Receive Unit */
#define CI_ASYNCMAP	2			/* Async Control Character Map */
#define CI_AUTHTYPE	3			/* Authentication Type */
#define CI_QUALITY	4			/* Quality Protocol */
#define CI_MAGICNUMBER	5		/* Magic Number */
#define CI_PCOMPRESSION	7		/* Protocol Field Compression */
#define CI_ACCOMPRESSION 8		/* Address/Control Field Compression */
#define CI_FCSALTERN	9		/* FCS-Alternatives */
#define CI_SDP		10			/* Self-Describing-Pad */
#define CI_NUMBERED	11			/* Numbered-Mode */
#define CI_CALLBACK	13			/* callback */
#define CI_MRRU		17			/* max reconstructed receive unit; multilink */
#define CI_SSNHF	18			/* short sequence numbers for multilink */
#define CI_EPDISC	19			/* endpoint discriminator */
#define CI_MPPLUS	22			/* Multi-Link-Plus-Procedure */
#define CI_LDISC	23			/* Link-Discriminator */
#define CI_LCPAUTH	24			/* LCP Authentication */
#define CI_COBS		25			/* Consistent Overhead Byte Stuffing */
#define CI_PREFELIS	26			/* Prefix Elision */
#define CI_MPHDRFMT	27			/* MP Header Format */
#define CI_I18N		28			/* Internationalization */
#define CI_SDL		29			/* Simple Data Link */

/*
 * LCP-specific packet types (code numbers).
 */
#define PROTREJ		8			/* Protocol Reject */
#define ECHOREQ		9			/* Echo Request */
#define ECHOREP		10			/* Echo Reply */
#define DISCREQ		11			/* Discard Request */
#define IDENTIF		12			/* Identification */
#define TIMEREM		13			/* Time Remaining */

/* Value used as data for CI_CALLBACK option */
#define CBCP_OPT	6			/* Use callback control protocol */

#if 0							/* moved to ppp_opts.h */
#define DEFMRU	1500			/* Try for this */
#define MINMRU	128				/* No MRUs below this */
#define MAXMRU	16384			/* Normally limit MRU to this */
#endif							/* moved to ppp_opts.h */

/* An endpoint discriminator, used with multilink. */
#define MAX_ENDP_LEN	20		/* maximum length of discriminator value */
struct epdisc {
	unsigned char class_;		/* -- The word "class" is reserved in C++. */
	unsigned char length;
	unsigned char value[MAX_ENDP_LEN];
};

/*
 * The state of options is described by an lcp_options structure.
 */
typedef struct lcp_options {
	unsigned int passive:1;		/* Don't die if we don't get a response */
	unsigned int silent:1;		/* Wait for the other end to start first */
#if 0							/* UNUSED */
	unsigned int restart:1;		/* Restart vs. exit after close */
#endif							/* UNUSED */
	unsigned int neg_mru:1;		/* Negotiate the MRU? */
	unsigned int neg_asyncmap:1;	/* Negotiate the async map? */
#if PAP_SUPPORT
	unsigned int neg_upap:1;	/* Ask for UPAP authentication? */
#endif							/* PAP_SUPPORT */
#if CHAP_SUPPORT
	unsigned int neg_chap:1;	/* Ask for CHAP authentication? */
#endif							/* CHAP_SUPPORT */
#if EAP_SUPPORT
	unsigned int neg_eap:1;		/* Ask for EAP authentication? */
#endif							/* EAP_SUPPORT */
	unsigned int neg_magicnumber:1;	/* Ask for magic number? */
	unsigned int neg_pcompression:1;	/* HDLC Protocol Field Compression? */
	unsigned int neg_accompression:1;	/* HDLC Address/Control Field Compression? */
#if LQR_SUPPORT
	unsigned int neg_lqr:1;		/* Negotiate use of Link Quality Reports */
#endif							/* LQR_SUPPORT */
	unsigned int neg_cbcp:1;	/* Negotiate use of CBCP */
#ifdef HAVE_MULTILINK
	unsigned int neg_mrru:1;	/* negotiate multilink MRRU */
#endif							/* HAVE_MULTILINK */
	unsigned int neg_ssnhf:1;	/* negotiate short sequence numbers */
	unsigned int neg_endpoint:1;	/* negotiate endpoint discriminator */

	u16_t mru;					/* Value of MRU */
#ifdef HAVE_MULTILINK
	u16_t mrru;					/* Value of MRRU, and multilink enable */
#endif							/* MULTILINK */
#if CHAP_SUPPORT
	u8_t chap_mdtype;			/* which MD types (hashing algorithm) */
#endif							/* CHAP_SUPPORT */
	u32_t asyncmap;				/* Value of async map */
	u32_t magicnumber;
	u8_t numloops;				/* Number of loops during magic number neg. */
#if LQR_SUPPORT
	u32_t lqr_period;			/* Reporting period for LQR 1/100ths second */
#endif							/* LQR_SUPPORT */
	struct epdisc endpoint;		/* endpoint discriminator */
} lcp_options;

void lcp_open(ppp_pcb * pcb);
void lcp_close(ppp_pcb * pcb, const char *reason);
void lcp_lowerup(ppp_pcb * pcb);
void lcp_lowerdown(ppp_pcb * pcb);
void lcp_sprotrej(ppp_pcb * pcb, u_char * p, int len);	/* send protocol reject */

extern const struct protent lcp_protent;

#if 0							/* moved to ppp_opts.h */
/* Default number of times we receive our magic number from the peer
   before deciding the link is looped-back. */
#define DEFLOOPBACKFAIL	10
#endif							/* moved to ppp_opts.h */

#endif							/* LCP_H */
#endif							/* PPP_SUPPORT */
